Conversation
…ing, type checking, and visual regression testing sections
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the README to better document local development and CI workflows, adding explicit linting/type-checking and Storybook visual regression testing (VRT) guidance.
Changes:
- Switches local dev instruction from
ng servetonpm run start. - Adds a new “Linting and type checking” section (lint, type-check, validate, lint-staged via Husky).
- Expands “Continuous integration” and adds a detailed “Visual regression testing for Storybook” section.
You can also share your feedback on Copilot code review. Take the survey.
Comment on lines
+106
to
+115
| GitHub Actions is split across three workflows: | ||
|
|
||
| 1. Build verification via `npm run build` | ||
| 2. Strict coverage verification via `npm run test:coverage` | ||
| 1. `.github/workflows/lint-and-typecheck.yml` | ||
| Runs `npm run lint` and `npm run type-check`. | ||
| 2. `.github/workflows/tests.yml` | ||
| Runs `npm run build`, `npm run test:coverage`, and `npm run e2e`. | ||
| 3. `.github/workflows/vrt.yml` | ||
| Builds Storybook, generates candidate visual-regression snapshots, and uploads review artifacts for pull requests. | ||
|
|
||
| The workflow is defined in `.github/workflows/ci.yml`. | ||
| The shared dependency bootstrap logic lives in `.github/actions/setup-ci/action.yml`. |
Comment on lines
+41
to
+47
| Commits also run `lint-staged` through Husky. Any staged `*.ts` files are processed with: | ||
|
|
||
| ```bash | ||
| eslint --fix | ||
| prettier --write | ||
| ``` | ||
|
|
| npm run e2e:vrt:ui | ||
| ``` | ||
|
|
||
| Snapshot baselines are stored in: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
…ing, type checking, and visual regression testing sections